<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../print.css" type="text/css" media="print">
<meta content="KapInspect,fr.kapit.KapInspect,height,width,x,y,app,logApplicationEvents,pluginModules,shortcut,useMouseShortcut,addDebugItem,addEventLogger,showPopup" name="keywords">
<title>fr.kapit.KapInspect</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'KapInspect - Simple data model API documentation';
				var baseRef = '../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">API Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../all-classes.html')" href="../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../all-classes.html')" href="../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../index-list.html')" href="../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../index.html?fr/kapit/KapInspect.html&amp;fr/kapit/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;KapInspect</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class KapInspect"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">fr.kapit</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class KapInspect</td>
</tr>
</table>
<p></p>
  This is the entry class to include KapInspect into your application in a static way
  It manages the keyboard shorcut and the display of popupInspector
  You will also use this class to inject values into the inspector 
  <p></p>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#app">app</a> : Application<div class="summaryTableDescription">[write-only]
   Specifies the application to be used in the main display list
   Should not be used in the normal case, as it is current application that is displayed
   In case where external applications should be loaded, then this application should be specified 
   here, before first use of KapInspect
   </div>
</td><td class="summaryTableOwnerCol">KapInspect</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#height">height</a> : int<div class="summaryTableDescription"></div>
</td><td class="summaryTableOwnerCol">KapInspect</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#logApplicationEvents">logApplicationEvents</a> : Boolean<div class="summaryTableDescription">[write-only]
   If true, then an chained EventLogguer will be created for your application.</div>
</td><td class="summaryTableOwnerCol">KapInspect</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#pluginModules">pluginModules</a> : String<div class="summaryTableDescription">[write-only]
   List of external modules to load
   </div>
</td><td class="summaryTableOwnerCol">KapInspect</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#shortcut">shortcut</a> : String<div class="summaryTableDescription">[write-only]
   The shortcut to launch KapInpect popup.</div>
</td><td class="summaryTableOwnerCol">KapInspect</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#useMouseShortcut">useMouseShortcut</a> : Boolean<div class="summaryTableDescription">[write-only]
   Sets the predefined mouse shortcut on/off 
   This shortcut is Ctrl+Alt+click, and is active by default
   Set this value to false if you wish to unactivate this shortcut
   </div>
</td><td class="summaryTableOwnerCol">KapInspect</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#width">width</a> : int<div class="summaryTableDescription"></div>
</td><td class="summaryTableOwnerCol">KapInspect</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#x">x</a> : int<div class="summaryTableDescription"></div>
</td><td class="summaryTableOwnerCol">KapInspect</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#y">y</a> : int<div class="summaryTableDescription"></div>
</td><td class="summaryTableOwnerCol">KapInspect</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#KapInspect()">KapInspect</a>()</div>
<div class="summaryTableDescription"></div>
</td><td class="summaryTableOwnerCol">KapInspect</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#addDebugItem()">addDebugItem</a>(item:Object, name:String = "", host:Object = null):void</div>
<div class="summaryTableDescription">[static]
   Add specific object in the inspector.</div>
</td><td class="summaryTableOwnerCol">KapInspect</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#addEventLogger()">addEventLogger</a>(item:Object, filters:EventFilters = null, chainEvents:Boolean = false, maxEvents:int = 500):void</div>
<div class="summaryTableDescription">[static]
   Static function to add events dispatched by some EventDispatcher instance in the application.</div>
</td><td class="summaryTableOwnerCol">KapInspect</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#showPopup()">showPopup</a>():void</div>
<div class="summaryTableDescription">
   Display the KapInspect popup.</div>
</td><td class="summaryTableOwnerCol">KapInspect</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="app"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">app</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>app:Application</code>&nbsp;&nbsp;[write-only]<p>
   Specifies the application to be used in the main display list
   Should not be used in the normal case, as it is current application that is displayed
   In case where external applications should be loaded, then this application should be specified 
   here, before first use of KapInspect
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set app(value:Application):void</code>
<br>
</div>
<a name="height"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">height</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var height:int</code>
</div>
<a name="logApplicationEvents"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">logApplicationEvents</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>logApplicationEvents:Boolean</code>&nbsp;&nbsp;[write-only]<p>
   If true, then an chained EventLogguer will be created for your application. 
   Try it, and you will know what events are dispatched during initialization phase of your application. 
   All children creation and add events will be monitored at all levels. 
   In this mode, there is no limit to the count of logged events, so this may slow your application especially if the logger is displayed.
   
   </p><p>The default value is <code>false</code>.</p>
<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set logApplicationEvents(value:Boolean):void</code>
<br>
</div>
<a name="pluginModules"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">pluginModules</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>pluginModules:String</code>&nbsp;&nbsp;[write-only]<p>
   List of external modules to load
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set pluginModules(value:String):void</code>
<br>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://lab.kapit.fr/display/kapinspect/Plugin+Development+Guide" target="mm_external">for further information on how to create plugin. Modules are specified by the name of the SWF file (without extension) They are analog to URL, and will be resolved either relatively to the folder of the main application either in an absolute way</a>
</div>
</div>
<a name="shortcut"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">shortcut</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>shortcut:String</code>&nbsp;&nbsp;[write-only]<p>
   The shortcut to launch KapInpect popup. The default one is control + alt + F12 (shortcut = "ctrl+alt+123")
   It is possible to set any combinaison of key.
   control is identified as "ctrl", alt and shift are the same string, separator is the caracter '+'
   The standard key is described by a keycode. See the list here: [http://msdn.microsoft.com/en-us/library/ms645540.aspx]
   
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set shortcut(value:String):void</code>
<br>
</div>
<a name="useMouseShortcut"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">useMouseShortcut</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>useMouseShortcut:Boolean</code>&nbsp;&nbsp;[write-only]<p>
   Sets the predefined mouse shortcut on/off 
   This shortcut is Ctrl+Alt+click, and is active by default
   Set this value to false if you wish to unactivate this shortcut
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set useMouseShortcut(value:Boolean):void</code>
<br>
</div>
<a name="width"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">width</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var width:int</code>
</div>
<a name="x"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">x</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var x:int</code>
</div>
<a name="y"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">y</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var y:int</code>
</div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="KapInspect()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">KapInspect</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function KapInspect()</code>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="addDebugItem()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">addDebugItem</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public static function addDebugItem(item:Object, name:String = "", host:Object = null):void</code><p>
   Add specific object in the inspector. As you can catch only display objects, it can be useful to inspect custom object like model locator.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">item</span>:Object</code> &mdash; The object to be inspected
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">name</span>:String</code> (default = "<code></code>")<code></code> &mdash; Optional. Name of the attribute that references the item into a host object (hostname = item)
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">host</span>:Object</code> (default = <code>null</code>)<code></code> &mdash; Optional. Reference to the host object, if any, that contains the item through the 'name' attribute.
   Specifying host and name will help KapInspect to watch changes on the object, if it is Bindable. 
   Name will also be used in the inspector tree as the label of the root node. This will help you to recognize the data.
   </td>
</tr>
</table>
</div>
<a name="addEventLogger()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">addEventLogger</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function addEventLogger(item:Object, filters:EventFilters = null, chainEvents:Boolean = false, maxEvents:int = 500):void</code><p>
   Static function to add events dispatched by some EventDispatcher instance in the application.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">item</span>:Object</code> &mdash;   the object to be watched for events. It must implements IEventDispatcher. Note that in this version, only "standard" events declared in the Flex frameworks will be watched.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">filters</span>:EventFilters</code> (default = <code>null</code>)<code></code> &mdash;  Optional. An instance of EventFilters class, used to know what event to trace or to filter. By default, the following events will be fitered out:
        <ul>
         <li>enterFrame</li>
         <li>render</li>
         <li>MouseEvent./li>
        </ul>
        This is to avoid too much events to be displayed initially. 
        <p>Default value if null</p>
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">chainEvents</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; Optional. If true, then event loggers will be chained on all children that will be created by the initial EventDispatcher item.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">maxEvents</span>:int</code> (default = <code>500</code>)<code></code> &mdash; maximum records allowed. Recording will stop after this value is reached. This prevents eventLogger to get stuck in a deadly loop, such as when you log events for the inspector itself 
   </td>
</tr>
</table>
</div>
<a name="showPopup()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">showPopup</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function showPopup():void</code><p>
   Display the KapInspect popup. Can be used in complement to the shortcut.
   </p></div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
